home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 August: Tool Chest / Dev.CD Aug 98 TC.toast / Tool Chest / Testing & Debugging / Mac OS Development Toolkit / Automation Essentials 2.3.0 / Host Automation Folder / Clouseau libs / Template.lib < prev   
Encoding:
Text File  |  1998-03-19  |  3.1 KB  |  95 lines  |  [TEXT/MPS ]
  1. #########################################################################
  2. #########################################################################
  3. ##                     Copyright © Apple Computer, Inc. 1993-1997
  4. ##                                All rights reserved
  5. #########################################################################
  6. #########################################################################
  7. #    
  8. #    Library:        Template.lib
  9. #    
  10. #    Version:        2.1.4
  11. #    
  12. #    Description:    This file contains examples of the standard commenting 
  13. #                    conventions for use with Clouseau libraries.  When these 
  14. #                    standards are followed, reference documentation can be 
  15. #                    extracted automatically from these headers using the 
  16. #                    MakeClouseauDocs MPW script.  -Jonathan Marsh, 3/25/93
  17. #            
  18. #    Contains:
  19. #    
  20. #    History:
  21. #        Date:        By:        Changes:
  22. #        03/25/93    JDM        Created
  23. #        09/04/95    SBR        Added this header for Radar 1273927
  24. #        06/01/96    SBR/MSO    Updated copyright header
  25. #                            Changed version number from 2.0.4 to 2.1d5
  26. #        01/21/97    SBR        Updated copyright for script/library files.
  27. #    
  28. #########################################################################
  29. #########################################################################
  30.  
  31.  
  32. Use this at the start of each script/Library file:
  33.  
  34. #########################################################################
  35. #########################################################################
  36. ##                     Copyright © Apple Computer, Inc. 199x-199x
  37. ##                                All rights reserved
  38. #########################################################################
  39. #########################################################################
  40. #    
  41. #    Library:        TheLibName.lib
  42. #    
  43. #    Version:        x.y.z
  44. #    
  45. #    Description:    This is a description. You can uncomment this section
  46. #                    to write longer passages and format it nicely, then 
  47. #                    comment it again.
  48. #            
  49. #    Contains:
  50. #        TheFirstTask()
  51. #        TheSecondTask()
  52. #    
  53. #    History:
  54. #        Date:        By:        Changes:
  55. #        00/00/00    ABC        Created
  56. #        00/00/00    DEF        Added a comment for such and such
  57. #    
  58. #########################################################################
  59. #########################################################################
  60.  
  61.  
  62. Use this to delimit blocks of tasks:
  63.  
  64. #########################################################################
  65. #########                    @@                                    #########
  66. #########################################################################
  67.  
  68.  
  69. Use this to head up each user-callable task.
  70.  
  71. #########################################################################
  72. #    task            @@()
  73. #∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞
  74. #    Description:    @@
  75. #    Parameters:        None
  76. #    Returns:        Nothing
  77. #    Examples:        @@();
  78. #    Assumptions:    None
  79. #∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞∞
  80. #    History:
  81. #        @@        @@        Created
  82. #########################################################################
  83.  
  84.  
  85. Use this to head up each internal task.
  86.  
  87. #########################################################################
  88. #    task            @@()
  89. #    Description:    @@
  90. #    Parameters:        None
  91. #    Returns:        Nothing
  92. #    History:
  93. #        @@        @@        Created
  94. #########################################################################
  95.